Emily Rust Lambda Boilerplate #101

AshtonStephens · 2024-05-01T20:14:49Z

Description

Creates a Rust boilerplate lambda that responds to the requests from the emily api spec with responses of the right 501 error format.

Build Annoyances

The autogenerated client makes updates to the API definition trivial as you can see with this update, but I'm not convinced the autobuilding setup with build.rs that I included in #99 is the whole solution.

How can we have the autogenerated client not cause cargo build to fail unless cargo build --package emily is run first?

Testing

Unit tests

AshtonStephens · 2024-05-01T20:58:37Z

emily/lambda/src/main.rs

+    #[test_case(Method::GET, "/chainstate/{height}", None; "get-chainstate")]
+    #[test_case(Method::PUT, "/chainstate/{height}", None; "set-chainstate")]
+    #[test_case(Method::POST, "/chainstate/{height}", None; "update-chainstate")]
+    #[tokio::test]


I'd rather have the test_case traits defined after tokio::test but unfortunately that's not possible. Not a big problem ~

Handle async test functions frondeus/test-case#48

AshtonStephens · 2024-05-01T21:31:12Z

Cargo.toml

+emily = { version = "0.1.0", path = ".generated-sources/emily" }
+tokio = "1.32.0"
+serde = "1.0"
+serde_json = "1.0"
+lambda_runtime = "0.11.1"
+aws_lambda_events = "0.15.0"
+http = "1.1.0"
+aws-sdk-dynamodb = { version = "1.3.0" }
+futures = "0.3.24"
+# This is necessary to compile the AWS Lambda as a lambda.
+openssl = { version = "0.10", features = ["vendored"] }


Should I be updating these in the workspace root, or on a package basis?

I'm okay with either, but I think workspace root makes the most sense.

As an aside, are you sure that openssl is necessary for AWS Lambda? As in, why wouldn't rustls work? I think this dependency is fine, since having it vendored makes potential compilation issues go away (I think), I just recall having issues with openssl when building with MUSL (might have been my fault, but still).

This bit is predictive of the next PR, I can remove it for this one. It's not great practice to include things needed for the next PR.

This is what it's needed for:

Emily Lambda CDK Template #103

As part of that PR we need to run this command to compile the .zip file that a is unpacked and run in the lambda.

cargo lambda build --release --output-format zip [--arm64]

The Cargo Lambda command uses shared object files during compilation, and MacOS uses the sources in the directory marked by the environment variable OPENSSL_DIR. The problem is mac uses files like libcrypto.3.dylib instead of libcrypto.3.so which is what the compiler needs.

After looking through a bunch of solutions this was the only thing that seemed to work across platforms. I also wonder if there was a better solution but this looks to be the standard one.

AshtonStephens · 2024-05-01T21:32:04Z

emily/lambda/src/main.rs

+
+        // Assert.
+        assert_eq!(response.status_code, 201);
+        assert_eq!(response.body.unwrap(), Body::Text("{\"bitcoinTxid\":\"BITCOIN_TXID_UNITTEST\",\"bitcoinTxOutputIndex\":0.0,\"recipient\":\"MOCK_RECIPIENT\",\"amount\":11111.0,\"status\":\"PENDING\",\"statusMessage\":\"MOCK_CREATE_DEPOSIT_RESPONSE\",\"parameters\":{\"maxFee\":33333.0,\"lockTime\":22222.0,\"reclaimScript\":\"MOCK_RECLAIM_SCRIPT\"}}".to_string()));


I know this is bad, this is just for the boilerplate.

Maybe it's okay

I think it's fine, especially so early in development.

djordon

As initial boilerplate, this looks fine. I did have a question about some of the generated models though.

djordon · 2024-05-02T03:06:05Z

Cargo.toml

+emily = { version = "0.1.0", path = ".generated-sources/emily" }
+tokio = "1.32.0"
+serde = "1.0"
+serde_json = "1.0"
+lambda_runtime = "0.11.1"
+aws_lambda_events = "0.15.0"
+http = "1.1.0"
+aws-sdk-dynamodb = { version = "1.3.0" }
+futures = "0.3.24"
+# This is necessary to compile the AWS Lambda as a lambda.
+openssl = { version = "0.10", features = ["vendored"] }


I'm okay with either, but I think workspace root makes the most sense.

As an aside, are you sure that openssl is necessary for AWS Lambda? As in, why wouldn't rustls work? I think this dependency is fine, since having it vendored makes potential compilation issues go away (I think), I just recall having issues with openssl when building with MUSL (might have been my fault, but still).

djordon · 2024-05-02T03:07:46Z

emily/lambda/src/main.rs

+                status: emily::models::OpStatus::Pending,
+                status_message: "MOCK_CREATE_DEPOSIT_RESPONSE".to_string(),
+                parameters: Box::new(DepositParameters {
+                    lock_time: Some(22222.0),


Wow, that's a long time.

Wait why is amount, lock_time, and max_fee not an integers?

It's just what the autogenerator provided, but I am not sure why it does that, the template specifically says Integer.

I don't know how, but I bet this has to do with JavaScript using the same "number" type for anything numeric 😅.

djordon · 2024-05-02T03:09:38Z

emily/lambda/src/main.rs

+
+        // Assert.
+        assert_eq!(response.status_code, 201);
+        assert_eq!(response.body.unwrap(), Body::Text("{\"bitcoinTxid\":\"BITCOIN_TXID_UNITTEST\",\"bitcoinTxOutputIndex\":0.0,\"recipient\":\"MOCK_RECIPIENT\",\"amount\":11111.0,\"status\":\"PENDING\",\"statusMessage\":\"MOCK_CREATE_DEPOSIT_RESPONSE\",\"parameters\":{\"maxFee\":33333.0,\"lockTime\":22222.0,\"reclaimScript\":\"MOCK_RECLAIM_SCRIPT\"}}".to_string()));


I think it's fine, especially so early in development.

netrome

Great stuff. I'd just like the TODOs to be addressed or labeled before seeing this merged.

emily/lambda/src/main.rs

Add NotImplementedError to Smithy API definition.

6c5fb45

AshtonStephens requested review from xoloki and djordon May 1, 2024 20:14

AshtonStephens linked an issue May 1, 2024 that may be closed by this pull request

Deposit API Rust Lambda Boilerplate #71

Closed

AshtonStephens force-pushed the 71-deposit-api-rust-lambda-boilerplate branch from 71456d6 to de0f5b3 Compare May 1, 2024 20:16

Create rust lambda boilerplace.

4c86ea5

AshtonStephens force-pushed the 71-deposit-api-rust-lambda-boilerplate branch from de0f5b3 to 4c86ea5 Compare May 1, 2024 20:17

Fix CI by forcing autogenerated sources to be made before cargo test.

1b085e5

AshtonStephens force-pushed the 71-deposit-api-rust-lambda-boilerplate branch from 33c2da9 to 1b085e5 Compare May 1, 2024 20:36

Remove incorrect comments.

1b76cff

AshtonStephens commented May 1, 2024

View reviewed changes

AshtonStephens marked this pull request as ready for review May 1, 2024 20:58

AshtonStephens requested a review from netrome May 1, 2024 20:59

AshtonStephens mentioned this pull request May 1, 2024

Emily Lambda CDK Template #103

Merged

remove unnecessary unused_extern_crates flag.

e374396

AshtonStephens self-assigned this May 1, 2024

AshtonStephens commented May 1, 2024

View reviewed changes

djordon approved these changes May 2, 2024

View reviewed changes

netrome reviewed May 2, 2024

View reviewed changes

emily/lambda/src/main.rs Outdated Show resolved Hide resolved

emily/lambda/src/main.rs Outdated Show resolved Hide resolved

emily/lambda/src/main.rs Outdated Show resolved Hide resolved

AshtonStephens mentioned this pull request May 2, 2024

[Feature]: Emily POST API Calls #111

Closed

3 tasks

AshtonStephens added 2 commits May 2, 2024 08:05

Address style changes and link TODO ticket

b41b347

Move main to be the first function in the lambda.

1fc4011

AshtonStephens requested a review from netrome May 2, 2024 12:12

netrome approved these changes May 2, 2024

View reviewed changes

AshtonStephens merged commit 6a9a5a3 into main May 2, 2024
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Emily Rust Lambda Boilerplate #101

Emily Rust Lambda Boilerplate #101

AshtonStephens commented May 1, 2024 •

edited

Loading

AshtonStephens May 1, 2024

AshtonStephens May 1, 2024 •

edited

Loading

djordon May 2, 2024

AshtonStephens May 2, 2024

AshtonStephens May 1, 2024 •

edited

Loading

AshtonStephens May 1, 2024

djordon May 2, 2024

djordon left a comment

djordon May 2, 2024

djordon May 2, 2024

djordon May 2, 2024

AshtonStephens May 2, 2024

netrome May 2, 2024

djordon May 2, 2024

netrome left a comment

Emily Rust Lambda Boilerplate #101

Emily Rust Lambda Boilerplate #101

Conversation

AshtonStephens commented May 1, 2024 • edited Loading

Description

Build Annoyances

Testing

Choose a reason for hiding this comment

AshtonStephens May 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AshtonStephens May 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

djordon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netrome left a comment

Choose a reason for hiding this comment

AshtonStephens commented May 1, 2024 •

edited

Loading

AshtonStephens May 1, 2024 •

edited

Loading

AshtonStephens May 1, 2024 •

edited

Loading